Reporting-ExportTemplates

[POST] /api/v2/reporting/export-templates

新增导出模板。

请求数据格式

ExportTemplateSettingsRequest

返回值

状态码: 200

成功

ExportTemplateAddResponse

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁忌

ReportingPluginError

[GET] /api/v2/reporting/export-templates

获取导出模板列表。

返回值

状态码: 200

成功

ExportTemplateSettingsResponse

状态码: 403

禁忌

ReportingPluginError

[PUT] /api/v2/reporting/export-templates/{exportTemplateId}

更新导出模板。

参数:

名称	类型	位置	描述
exportTemplateId必填项	string	path	导出模板 ID。例如：eb6d614f-e595-4de6-8c51-c54c6b07c295

请求数据格式

ExportTemplateSettingsRequest

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁忌

ReportingPluginError

[DELETE] /api/v2/reporting/export-templates/{exportTemplateId}

删除导出模板。

参数:

名称	类型	位置	描述
exportTemplateId必填项	string	path	导出模板 ID。例如：eb6d614f-e595-4de6-8c51-c54c6b07c295

返回值

状态码: 200

成功

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁忌

ReportingPluginError

[GET] /api/v2/reporting/export-templates/count

获取导出模板的数量。

返回值

状态码: 200

成功

ExportTemplateCountResponse

状态码: 403

禁忌

ReportingPluginError

[GET] /api/v2/reporting/export-templates/{targetPlaces}

按目标位置获取导出模板设置列表。

参数:

名称	类型	位置	描述
targetPlaces必填项	string	path	可接受的值：API、Scheduler、Viewer、Portal、All 及其组合，以逗号分隔。

返回值

状态码: 200

成功

ExportTemplateSettingsResponse

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁忌

ReportingPluginError

类型定义

Ƭ ExportTemplateAddResponse

添加导出模板响应模型。

名称	类型	描述	示例
id可为空	string	导出模板 ID。

Ƭ ReportingPluginError

报告插件错误

名称	类型	描述	示例
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文

Ƭ ExportTemplateSettingsRequest

导出模板设置请求模型。

名称	类型	描述	示例
description	string	导出模板描述。
exportType	ExportType
name	string	导出模板的名称。
roles	Array<string>	可导出模板的角色。	["Everyone"]
targetPlaces	TargetPlaces
exportSettings	any	导出设置。	{"Version":"Pdf14","Title":"Example title"}
allowedSettings	Boolean	允许的设置。	{"Version":true,"Author":true}
index	int32	对索引进行排序。	1
icon	ExportTemplateIcon

Ƭ ExportType

Enum:

• Pdf
• Excel
• Exceldata
• Docx
• Csv
• Html
• Image
• Json
• Txt
• Xml

导出类型

* Pdf - 0 - PDF
* Excel - 1 - Excel
* Exceldata - 2 - Excel 数据
* Docx - 3 - Word
* Csv - 4 - CSV
* Html - 5 - HTML
* Image - 6 - 图片
* Json - 7 - JSON
* Txt - 8 - TXT
* Xml - 9 - XML

Ƭ TargetPlaces

Enum:

• None
• API
• Scheduler
• Viewer
• Portal
• All

模板可用位置列表。

* None - 0 - 无
* API - 1 - API
* Scheduler - 2 - 调度程序
* Viewer - 4 - 查看器
* Portal - 8 - 门户
* All - 15 - 全部

Ƭ ExportTemplateIcon

导出模板图标模型。

名称	类型	描述	示例
type可为空	string	导出模板图标类型。
name可为空	string	导出模板图标名称。
color可为空	string	导出模板图标颜色。
value可为空	string	导出模板自定义图标值。

Ƭ ExportTemplateSettingsResponse

导出模板设置响应模型。

名称	类型	描述	示例
id可为空	string	导出模板 ID。
description可为空	string	导出模板描述。
exportType可为空	string	导出模板的导出类型。
name可为空	string	导出模板的名称。
roles可为空	Array<string>	可导出模板的角色。
targetPlaces	TargetPlaces
exportSettings可为空	any	导出设置。
allowedSettings可为空	Boolean	允许的设置。
index	int32	对索引进行排序。
icon	ExportTemplateIcon

Ƭ ExportTemplateCountResponse

导出模板响应模型的数量。

名称	类型	描述	示例
count	int32	导出模板数量。